GetHotSpotsDiagramWithHotSpots (Method)

Request (GetHotSpotsDiagramWithHotSpotsSoapIn)

The request body is of type GetHotSpotsDiagramWithHotSpots.

Request Body Parameters

Name	Description	Data Type
Diagram_ID		xml:int

Example

The following example shows how to perform the web operation in CyberStore.

Javascript

// Example: Get all Diagram and Hot Spot data
//      for the Diagram with Diagram_ID = 2
// then send the response to the browser console

MakeAJAXCall("Inventory.GetHotSpotsDiagramWithHotSpots", {
    Diagram_ID: 2
}, console.log);

200 Response (GetHotSpotsDiagramWithHotSpotsSoapOut)

The response body is of type GetHotSpotsDiagramWithHotSpotsResponse.

Response Body Parameters

Name	Description	Data Type
GetHotSpotsDiagramWithHotSpotsResult	A string value containing a JSON object. { "ID": 2, "Name": "Adventure Series Bicycle Diagram", "Headline": "Available Parts for all A Series Adventure Bikes", "Description": "", "ImagePath": "/Ecommerce/site/images/Diagrams/BicycleParts.png", "Radius": 7, "Border": true, "BorderColor": "#FF0000", "BorderWidth": 3, "BorderOpacity": 0.75, "Fill": true, "FillColor": "#FF9900", "FillOpacity": 0.5, "HighlightFill": true, "HighlightFillColor": "#FF0000", "HighlightFillOpacity": 0.5, "SelectedFill": true, "SelectedFillColor": "333399", "SelectedFillOpacity": 0.75, "Title": null, "MetaKeywords": null, "MetaDescription": null, "HotSpots": [ { "HotSpot_ID": 13, "XCoords": 529, "YCoords": 145, "Description": "", "Reference": "20", "RequiredQuantity": 1, "Item_ID": 623, "StockCode": "B114", "Name": "Radially Spoked Front Wheel", "LongDescription2": "Sub Assembly", "Headline": "", "SubHeadline": "", "ShortDescription": "Radially Spoked Front Wheel", "SortOrder": 2, "Unique_ID": "hotSpot_H13_I623" }, { "HotSpot_ID": 14, "XCoords": 474, "YCoords": 14, "Description": "", "Reference": "1", "RequiredQuantity": 1, "Item_ID": 622, "StockCode": "B113", "Name": "Handle Bar Assembly", "LongDescription2": "Sub Assembly", "Headline": "", "SubHeadline": "", "ShortDescription": "Handle Bar Assembly", "SortOrder": 4, "Unique_ID": "hotSpot_H14_I622" }, { "HotSpot_ID": 15, "XCoords": 146, "YCoords": 44, "Description": "", "Reference": "30", "RequiredQuantity": 2, "Item_ID": 623, "StockCode": "B114", "Name": "Radially Spoked Front Wheel", "LongDescription2": "Sub Assembly", "Headline": "", "SubHeadline": "", "ShortDescription": "Radially Spoked Front Wheel", "SortOrder": 6, "Unique_ID": "hotSpot_H15_I623" } ] }	xml:string

Name

Description

Data Type

GetHotSpotsDiagramWithHotSpotsResult

A string value containing a JSON object.

{
    "ID": 2,
    "Name": "Adventure Series Bicycle Diagram",
    "Headline": "Available Parts for all A Series Adventure Bikes",
    "Description": "",
    "ImagePath": "/Ecommerce/site/images/Diagrams/BicycleParts.png",
    "Radius": 7,
    "Border": true,
    "BorderColor": "#FF0000",
    "BorderWidth": 3,
    "BorderOpacity": 0.75,
    "Fill": true,
    "FillColor": "#FF9900",
    "FillOpacity": 0.5,
    "HighlightFill": true,
    "HighlightFillColor": "#FF0000",
    "HighlightFillOpacity": 0.5,
    "SelectedFill": true,
    "SelectedFillColor": "333399",
    "SelectedFillOpacity": 0.75,
    "Title": null,
    "MetaKeywords": null,
    "MetaDescription": null,
    "HotSpots": [
        {
            "HotSpot_ID": 13,
            "XCoords": 529,
            "YCoords": 145,
            "Description": "",
            "Reference": "20",
            "RequiredQuantity": 1,
            "Item_ID": 623,
            "StockCode": "B114",
            "Name": "Radially Spoked Front Wheel",
            "LongDescription2": "Sub Assembly",
            "Headline": "",
            "SubHeadline": "",
            "ShortDescription": "Radially Spoked Front Wheel",
            "SortOrder": 2,
            "Unique_ID": "hotSpot_H13_I623"
        },
        {
            "HotSpot_ID": 14,
            "XCoords": 474,
            "YCoords": 14,
            "Description": "",
            "Reference": "1",
            "RequiredQuantity": 1,
            "Item_ID": 622,
            "StockCode": "B113",
            "Name": "Handle Bar Assembly",
            "LongDescription2": "Sub Assembly",
            "Headline": "",
            "SubHeadline": "",
            "ShortDescription": "Handle Bar Assembly",
            "SortOrder": 4,
            "Unique_ID": "hotSpot_H14_I622"
        },
        {
            "HotSpot_ID": 15,
            "XCoords": 146,
            "YCoords": 44,
            "Description": "",
            "Reference": "30",
            "RequiredQuantity": 2,
            "Item_ID": 623,
            "StockCode": "B114",
            "Name": "Radially Spoked Front Wheel",
            "LongDescription2": "Sub Assembly",
            "Headline": "",
            "SubHeadline": "",
            "ShortDescription": "Radially Spoked Front Wheel",
            "SortOrder": 6,
            "Unique_ID": "hotSpot_H15_I623"
        }
    ]
}

xml:string